home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
EnigmA Amiga Run 1995 November
/
EnigmA AMIGA RUN 02 (1995)(G.R. Edizioni)(IT)[!][issue 1995-11][Skylink CD].iso
/
earcd
/
util
/
text
/
words3.lha
/
Words
/
SpellIT
/
Manual
< prev
next >
Wrap
Text File
|
1995-08-06
|
8KB
|
175 lines
SPELLIT
SpellIt is a spell checker for GoldED. It is based on the ISpell package
available for several machines including the PC and Amiga (thus providing
access to existing dictionaries). SpellIT is not language-dependent: just
load a dictionary file you are interested in. ISpell (including a dictionary)
is freeware; it has been released on a Fish disk.
FEATURES:
o ability to check existing files
o fast online checking while typing
o suggests replacements
o localized
o user dictionary, extendable
o fully integrated into the GoldED environment
INSTALLATION
Run the Words install script to have ISpell, SpellIT, the dictionaries and a
syntax parser installed. The installer script modifies your GoldED
configuration: it adds SpellIT to the list of API clients and it loads the
WarpSPELL syntax parser. You should save the new configuration if you don't
want to loose the changes.
Once installed, SpellIT will launch ISpell and (if ISpell has been launched
successfully) add a new SPELL command to GoldED's command set. Use this
command as if it were an internal editor command: assign it to menus, to
keyboard events, use it within the command requester or within ARexx macros.
Ready-to-use presets (a menu preset and a keyboard preset) are available;
they are described later on. The SPELL syntax according to AmigaDOS rules:
Description of the SPELL command
command option description
--------------------------------------------------------------------------
SPELL ABOUT/S display copyright information related to SpellIT
ONLINE/K turn online spell checking on/off
ASK/K online checking: display suggestions ?
NEXT/S move to next error
SUGGEST/S show suggestions related to word under cursor
VOLUME/N error beep volume (0...63)
ADD/S add word under cursor to user dictionary
CURRENT/S check word
TEX/K ignore words introduced by "\" (TeX style commands)
The option type is described by the slash/letter combinations appended to the
option name (you may use a combination of several options): \S options are
switches, turning a feature <on> if they are given at all. They are used
without further arguments. \K options are different: they require arguments
(either TRUE, FALSE or TOGGLE): Example: SPELL ONLINE=TRUE. \K options turn
features <on> or <off> according to the provided argument. Finally, there are
\N options - they are used to pass numerical values (e.g. SPELL VOLUME=20).
Example (combined options):
Open GoldED's command requester (misc menu) and enter SPELL CURRENT ASK=TRUE
to make SpellIT check the word under the cursor and display a list of
suggested replacements if the spelling is rated wrong or unknown.
MENU
SpellIT is distributed with a ready-to-use menu preset (SpellIT_E.men): Open
GoldED's menu requester and append that menu file to your current menus using
the <append> gadget. The new 'SpellIT' menu features the following entries:
-----------------
|about SpellIT |
|---------------|
|next error |
|check word |
|---------------|
|learn word |
|refresh display|
|---------------|
|\/ online check|
|\/ suggestions |
|---------------|
|error beep |
-----------------
ABOUT SPELLIT
Displays copyright and version information related to SpellIT. Besides,
you'll find an e-mail address providing GoldED support. Check the GoldED
manual for details.
NEXT ERROR
Move cursor to next error. If there is no further error (beware :-) a short
note pops up. Folded lines are not scanned for errors. Unfold them if you
want to have them considered.
CHECK WORD
Checks the current word. Issues a beep if it is considered to be misspelled.
If you have asked for replacement suggestions (see SUGGESTIONS below) and if
ISpell is able to provide some, a list pops up. Use the cursor keys to move
within the list. Use <RETURN> to accept a selection respectively <ESC> to
quit without selection.
LEARN WORD
Adds the word under the cursor to the user dictionary. Words are added to the
online dictionary in RAM and not saved to the disk based user dictionary
immediately. However, during closedown of SpellIT (SpellIT is closed down if
you leave GoldED) you are asked wether you want to have the new words added
to the disk based dictionary, too.
REFRESH DISPLAY
This menu won't be of any use unless you have installed the WarpSPELL syntax
parser (available at the support BBS). The WarpSPELL parser highlights all
unknown words found within a text. Use this menu after having learned new
words to make the editor refresh the highlighting scheme and thus reflect the
dictionary changes.
ONLINE CHECK
Turns online spell checking on respectively off (SpellIT utilizes the user
variable USER19 of GoldED to remember the current mode). Your input is
spellchecked while typing if online checking is enabled: Once you have
entered a word, ISpell has a look at it. A word is considered 'entered' if a
white space character reaches GoldED (including space, colon, and several
more). You should enter a space even after the last word of a line to ensure
a check (or switch the editor to word wrap mode and don't use <return> at
all). Errors are announced by a beep and (if SUGGESTIONS is active ; see
below) a list of replacement suggestions.
SUGGESTIONS
Turns generations of replacement suggestions <on> respectively <off> (see
CHECK CURRENT and ONLINE CHECK above). SpellIT utilizes GoldED's user
variable USER20 to remember the current mode.
ERROR BEEP
Sets the error beep volume. The OS function DisplayBeep() is used if the
error beep is turned off completely (volume = 0), usually causing the display
to flash.
@{Keyboard}
Keyboard assignments of several function keys have been changed during
SpellIT installation (if requested) to provide fast access to the new
features of SpellIT. Keyboard shortcuts are handled much faster by GoldED
than menu selections due to the way menu selections are buffered by the OS.
New keyboard assignments:
F6 ............ online spell checking ON
SHIFT-F6 ............ online spell checking OFF
F7 ............ move cursor to next error
F8 ............ check word under cursor
F9 ............ learn word under cursor
F10 ........... normal error beep
SHIFT-F10 ........... low beep
AUTHOR
Feel free to e-mail me bug reports, comments or suggestions. Current e-mail
address is DIETMAR@TOMATE.TNG.OCHE.DE. Don't send me normal letters. I
wouldn't have the time to answer them. I don't offer updates on disks, check
your local BBS instead. Disks reaching me are put to a good cause (preferably
backups :-).
Dietmar Eilert
Mies-v-d-Rohe-Str.31, 52074 Aachen, Germany
E-Mail: DIETMAR@TOMATE.TNG.OCHE.DE
Tel: +49-(0)241-81665
+49-(0)2525-7776
Fax: +49-(0)241-81665